Eclipse Platform
Pre-release 3.0

org.eclipse.ui.texteditor.quickdiff
Interface IQuickDiffProviderImplementation

All Superinterfaces:
IQuickDiffReferenceProvider

public interface IQuickDiffProviderImplementation
extends IQuickDiffReferenceProvider

Describes a reference provider for the quick diff facility. Any extension to the quickdiff.referenceprovider extension point has to provide a class implementing this interface.

Extenders must provider a zero-arg constructor in order for the plug-in class loading mechanism to work.

Since:
3.0

Method Summary
 boolean isEnabled()
          Gives the implementation a hook to publish its enablement.
 void setActiveEditor(ITextEditor editor)
          Sets the active editor for the provider implementation.
 void setId(String id)
          Sets the id of this implementation.
 
Methods inherited from interface org.eclipse.ui.texteditor.quickdiff.IQuickDiffReferenceProvider
dispose, getId, getReference
 

Method Detail

setActiveEditor

public void setActiveEditor(ITextEditor editor)
Sets the active editor for the provider implementation. Will usually just be called right after creation of the implementation.

Parameters:
editor - the active editor.

isEnabled

public boolean isEnabled()
Gives the implementation a hook to publish its enablement. The action corresponding to this implementation might be grayed out or not shown at all based on the value presented here.

Returns:
false if the implementation cannot be executed, true if it can, or if it cannot be decided yet.

setId

public void setId(String id)
Sets the id of this implementation. This method will be called right after creation, and id will be set to the Id attribute specified in the extension's declaration.

Parameters:
id - the provider's new id.

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.